Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pkg/sql: use ring.Buffer in StmtBuf #41379

Merged
merged 2 commits into from
Oct 10, 2019

Conversation

nvanbenschoten
Copy link
Member

The StmtBuf has the exact access patterns typically associated with a ring buffer. Command instances are added to the back of the buffer and trimmed from the front of the buffer. These operations are often performed in lockstep, but that is not always the case, so we need the buffer to be able to grow.

ring.Buffer provides exactly these semantics and it allows us to avoid memory allocations on each Command in StmtBuf.Push.

Release justification: None. Don't merge until branch is split.

This commit cleans up and extends the ring buffer package. In addition to
improving testing and making the code more uniform, it makes the following
changes:
- adds a Cap method
- adds a Reserve method
- starts the buffer with a capacity of 1 instead of jumping up to 8. This
  makes the buffer optimal when the maximum size it ever reaches is 1.
  This mirrors how Go slices grow, for the same reason.

Release justification: None. Don't merge.

Release note: None
The StmtBuf has the exact access patterns typically associated with a
ring buffer. Command instances are added to the back of the buffer and
trimmed from the front of the buffer. These operations are often performed
in lockstep, but that is not always the case, so we need the buffer to be
able to grow.

`ring.Buffer` provides exactly these semantics and it allows us to avoid
memory allocations on each Command in `StmtBuf.Push`.

Release justification: None. Don't merge until branch is split.

Release note: None
@cockroach-teamcity
Copy link
Member

This change is Reviewable

Copy link
Contributor

@andreimatei andreimatei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but I don't understand exactly what allocation we're avoiding. Could you edify me?

Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained (waiting on @andreimatei)

@nvanbenschoten
Copy link
Member Author

The key is that the old approach had a slice that it was appending to and truncating from the front. This resulted in behavior analogous to the following:

func BenchmarkAppendTruncate(b *testing.B) {
	var a []int
	for i := 0; i < b.N; i++ {
		a = append(a, 1)
		a = a[1:]
	}
}

// BenchmarkAppendTruncate-16   100000000   16.3 ns/op   8 B/op   1 allocs/op

The slice oscillates between a length of 0 and 1 and has to allocate on each append.

@nvanbenschoten
Copy link
Member Author

bors r+

@nvanbenschoten
Copy link
Member Author

bors crash:

{:timeout,
 {GenServer, :call,
  [
    BorsNG.GitHub,
    {:synthesize_commit,
     {{:installation, 117629}, 16563587},
     {%{
        branch: "staging",
        commit_message: "Merge #41358 #41371 #41372 #41379\n\n41358: sql/logictest: add logictest for all expected 1PC txn statements r=nvanbenschoten a=nvanbenschoten\n\nFirst commit from #41324.\r\n\r\nWe expect a selection of simple single-statement mutations to hit the\r\n\"1-phase commit\" transaction fast-path. #41320 demonstrated how critical\r\nthis is, as regressions here can cause major (> 50%) performance hits to\r\nbenchmarks and user workloads. This commit adds a logic test to validate\r\nthat these statements continue to hit this fast-path.\r\n\r\nRelease justification: Testing only.\n\n41371: kv: avoid allocations in client.Txn constructor r=nvanbenschoten a=nvanbenschoten\n\nThis PR contains two small wins that help speed up the client.Txn constructor, which is responsible for **2.90%** of a CPU profile when running Sysbench's `oltp_point_select` workload. The biggest win here will come from addressing https://github.com/cockroachdb/cockroach/issues/32508.\r\n\r\n#### kv: lazily create *RangeIterator in txnPipeliner\r\n\r\nThis allocation was responsible for **0.34%** of a CPU profile when running Sysbench's `oltp_point_select` workload.\r\n\r\n#### kv: only re-alloc refresh spans in augmentMetaLocked if necessary\r\n\r\nThis was responsible for **0.057%** of a CPU profile when running Sysbench's `oltp_point_select` workload.\r\n\r\nRelease justification: None. These can wait for the branch to split.\n\n41372: sql/pgwire: statically allocate format code slice for all text args/cols r=nvanbenschoten a=nvanbenschoten\n\nThis allocation was responsible for **0.8%** of a CPU profile when running\r\nSysbench's oltp_point_select workload.\r\n\r\nRelease justification: Probably none, although this does look very safe.\r\n\r\nRelease note: None\n\n41379: pkg/sql: use ring.Buffer in StmtBuf r=nvanbenschoten a=nvanbenschoten\n\nThe StmtBuf has the exact access patterns typically associated with a ring buffer. Command instances are added to the back of the buffer and trimmed from the front of the buffer. These operations are often performed in lockstep, but that is not always the case, so we need the buffer to be able to grow.\r\n\r\n`ring.Buffer` provides exactly these semantics and it allows us to avoid memory allocations on each Command in `StmtBuf.Push`.\r\n\r\nRelease justification: None. Don't merge until branch is split.\n\nCo-authored-by: Nathan VanBenschoten <nvanbenschoten@gmail.com>\n",
        committer: %{
          email: "bors@cockroachlabs.com",
          name: "craig[bot]"
        },
        parents: ["6d79c7a4f36acd10c410a87ab9bddf3580f28748",
         "a0dde23104734fc2f0ae88397896686433963630",
         "9d682e9c6c112f9246456a1548dc4d3842031257",
         "fdbf14e2395444e68535a30d5be3145750e5b296",
         "42ec21dd7deef1bd5616ea663db0d6b4fe436c91"],
        tree: "6291963028f8f3aeadff552af89a617a6ee464ab"
      }}},
    10000
  ]}}

bors r+

craig bot pushed a commit that referenced this pull request Oct 10, 2019
41356: Revert "opt: disallow mutations under union" r=RaduBerinde a=RaduBerinde

This reverts commit a34d705.

Release justification: recently merge fix no longer needed (thanks
to #41307).

Release note (sql change): Mutations under UNION or UNION ALL are
allowed again.

41358: sql/logictest: add logictest for all expected 1PC txn statements r=nvanbenschoten a=nvanbenschoten

First commit from #41324.

We expect a selection of simple single-statement mutations to hit the
"1-phase commit" transaction fast-path. #41320 demonstrated how critical
this is, as regressions here can cause major (> 50%) performance hits to
benchmarks and user workloads. This commit adds a logic test to validate
that these statements continue to hit this fast-path.

Release justification: Testing only.

41371: kv: avoid allocations in client.Txn constructor r=nvanbenschoten a=nvanbenschoten

This PR contains two small wins that help speed up the client.Txn constructor, which is responsible for **2.90%** of a CPU profile when running Sysbench's `oltp_point_select` workload. The biggest win here will come from addressing #32508.

#### kv: lazily create *RangeIterator in txnPipeliner

This allocation was responsible for **0.34%** of a CPU profile when running Sysbench's `oltp_point_select` workload.

#### kv: only re-alloc refresh spans in augmentMetaLocked if necessary

This was responsible for **0.057%** of a CPU profile when running Sysbench's `oltp_point_select` workload.

Release justification: None. These can wait for the branch to split.

41372: sql/pgwire: statically allocate format code slice for all text args/cols r=nvanbenschoten a=nvanbenschoten

This allocation was responsible for **0.8%** of a CPU profile when running
Sysbench's oltp_point_select workload.

Release justification: Probably none, although this does look very safe.

Release note: None

41379: pkg/sql: use ring.Buffer in StmtBuf r=nvanbenschoten a=nvanbenschoten

The StmtBuf has the exact access patterns typically associated with a ring buffer. Command instances are added to the back of the buffer and trimmed from the front of the buffer. These operations are often performed in lockstep, but that is not always the case, so we need the buffer to be able to grow.

`ring.Buffer` provides exactly these semantics and it allows us to avoid memory allocations on each Command in `StmtBuf.Push`.

Release justification: None. Don't merge until branch is split.

Co-authored-by: Radu Berinde <radu@cockroachlabs.com>
Co-authored-by: Nathan VanBenschoten <nvanbenschoten@gmail.com>
@craig
Copy link
Contributor

craig bot commented Oct 10, 2019

Build succeeded

@craig craig bot merged commit 42ec21d into cockroachdb:master Oct 10, 2019
@nvanbenschoten nvanbenschoten deleted the nvanbenschoten/stmtBufRing branch October 17, 2019 20:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants